home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 007 / cedadds.arc / READ.ME < prev   
Text File  |  1987-04-29  |  5KB  |  126 lines
  1.                                   February 16, 1987
  2.  
  3.     PUSHD / POPD  and new CD for MS-DOS
  4.     -----------------------------------
  5.  
  6.  
  7. Introduction:
  8.     About a week ago, I received the Command EDitor CED (by J.C.Dunford).
  9.     For this program I wrote two additional utilities. They give you the
  10.     following new commands:
  11.  
  12.         PUSHD        saves current directory on a stack
  13.         POPD        pop's back to a dir saved by PUSHD
  14.                 (makes it current again)
  15.  
  16.         CD        works like the original, but also evaluates
  17.                 the environement variable CDPATH
  18.  
  19.  
  20. How do they work:
  21.                 PUSHD/POPD
  22.     PUSHD saves the current directory on stack which may hold no more than
  23.     five entries.
  24.     With the command POPD you automatically change back to the next saved
  25.     directory.
  26.  
  27.                     CD
  28.     Basically, it works the same way as the COMMAND.COM's CD it replaces.
  29.     The current parameter is changed to the pathname given as the one and
  30.     only parameter. In case of an error, it also searches the directories
  31.     specified in the environement string CDPATH for that directory you'd
  32.     like to make the current one. This, of course, only happens if the
  33.     specified parameter doesn't start with '\' nor '/'. If all these
  34.     attempts to change the current directory fail, it's time for an error
  35.     message.
  36.  
  37.  
  38. Usage:
  39.     One possible use for PUSHD/POPD is with sidekick. You can't use the
  40.     help file unless you start sidekick in the same directory. (Perhaps
  41.     there is another way. If so, I'm missing it. BTW, I don't use sk
  42.     often). The following isn't of much use for those of you who start
  43.     sidekick in the AUTOEXEC.BAT. All the others might try:
  44.  
  45.         CED SYN sk pushd^cd \your-sk-directory^sk^popd
  46.  
  47.     If you'd like to use sidekick, just type sk. This installs it and
  48.     leaves you in the directory you were in before.
  49.  
  50.     Usage for the new CD should be obvious. Some hints for defining the
  51.     environement string CDPATH: It contains a list of the directories which
  52.     you want to be searched for the directory. Each one is separated by ';'
  53.     from the previous one. Don't terminate an entry with '\' or '/'. This
  54.     will lead to an error. If you'd like to include the root, just start
  55.     the string with ';' or include ';;' somewhere in the string. The
  56.     directories are searched in the order you list them in CDPATH. The
  57.     environement must be defined at the time you load this routine into
  58.     ram. Any changes after that time aren't reflected.
  59.  
  60.  
  61. Configuration:
  62.     In the sources you can change some limits to your taste. For PUSHD/POPD
  63.     you'll find a definition for a constant called 'entries'. It specifies
  64.     the depth of the stack (the number of entries, the stack can hold). At
  65.     present, its value is set to five.
  66.     The new CD uses a constant called 'cdlength' which specifies the max.
  67.     length of the environement variable CDPATH. The default is 255. Any
  68.     characters exceeding that length are truncated.
  69.     As a parameter to the command NEWCD which installs the new CD command,
  70.     you can specify if CD without a parameter changes to the root or if it
  71.     prints the name of the current directory. Default is changing to the
  72.     root. If the loader detects a 'p'or a 'P'in one of the following
  73.     parameters, CD without a parameter prints the current directory. (Yes,
  74.     I am lazy.)
  75.     The names of the commands must be changed in the sources. You'll find 
  76.     their definitions are at the end of the sources.
  77.     
  78.  
  79. In case of an error:
  80.     I didn't test them very hard. This is especially true for the parameter
  81.     parsing routines. On my system, an IBM-PC/AT-compatible, I tested the
  82.     basic functions, and they seem to work.
  83.  
  84.     If the two programs won't work on your system, please uninstall all
  85.     the resident software. This is one possible cause of malfunction since
  86.     PUSHD/POPD and CD reside in RAM, too.
  87.     At least on TSR is known to cause bad surprises: Ramkey by Quaid
  88.     Software Limited. Don't ask me what this one is good for. A friend,
  89.     who uses it, told me of its bad effect.
  90.  
  91.  
  92. Limitations:
  93.     There is an additional limitation to these two programs (and to
  94.     extensions to COMMAND.COM using CED in general): You can't use them
  95.     in .BAT files. CED monitors the keyboard input and commands read from
  96.     .BAT files aren't evaluated that way. But you can use them in synonyms,
  97.     of course. The 'original' CD, the one defined by COMMAND.COM, still
  98.     works in batch-files. Though, you can't use the features brought to you
  99.     by the new CD.
  100.  
  101.  
  102. Flames:
  103.     These are my first assembler programs since about one and half a year.
  104.     I didn't have an assembler handbook ready, too. So, if you find 'bad'
  105.     code (e.g. too much statements), feel free to patch them. It would be
  106.     nice if you dropped me a note on this subject.
  107.     Don't send me any flames concerning my programming style nor my
  108.     english writing. I think, very few of you would understand a word if I
  109.     wrote the doc and the comments in swiss german :-).
  110.  
  111.  
  112. Public Domain:
  113.     I place these two programs in the public domain and you may make as
  114.     much copies as you like. You may distribute it for non commercial use
  115.     only and you have to include the sources.
  116.  
  117.  
  118.  
  119.     Have a nice day,
  120.  
  121.        ...urs zurbuchen
  122.  
  123.  
  124.     PS: One nice feature of the new CD: You may use \ or / as directory
  125.         delimiter. But remember, this is only valid for CD.
  126.